/**
******************************************************************************
* @file    ics_f4xx_pwm_curr_fdbk.h
* @author  Motor Control SDK Team, ST Microelectronics
* @brief   This file contains all definitions and functions prototypes for the
*          ICS PWM current feedback component for F4xx of the Motor Control SDK.
******************************************************************************
* @attention
*
* <h2><center>&copy; Copyright (c) 2018 STMicroelectronics International N.V.
* All rights reserved.</center></h2>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted, provided that the following conditions are met:
*
* 1. Redistribution of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
* 3. Neither the name of STMicroelectronics nor the names of other
*    contributors to this software may be used to endorse or promote products
*    derived from this software without specific written permission.
* 4. This software, including modifications and/or derivative works of this
*    software, must execute solely and exclusively on microcontroller or
*    microprocessor devices manufactured by or for STMicroelectronics.
* 5. Redistribution and use of this software other than as permitted under
*    this license is void and will automatically terminate your rights under
*    this license.
*
* THIS SOFTWARE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
* PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY
* RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT
* SHALL STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
******************************************************************************
  * @ingroup ics_f4xx_pwm_curr_fdbk
*/

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __ICS_F4XX_PWMNCURRFDBK_H
#define __ICS_F4XX_PWMNCURRFDBK_H

#include "pwm_curr_fdbk.h"
#include "ics_dd_pwmncurrfdbk.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/** @addtogroup MCSDK
  * @{
  */

/** @addtogroup pwm_curr_fdbk
  * @{
  */

/** @addtogroup ics_f4xx_pwm_curr_fdbk
* @{
*/

#define SOFOC 0x0008u /**< This flag is reset at the beginning of FOC
                           and it is set in the TIM UP IRQ. If at the end of
                           FOC this flag is set, it means that FOC rate is too 
                           high and thus an error is generated */

/**
* @brief  PWMnCurrFdbk ICS F4xx handle
*/
typedef struct
{
  PWMC_Handle_t _Super;     /**< PWMC handler */
  uint32_t wPhaseAOffset;   /**< Offset of Phase A current sensing network  */
  uint32_t wPhaseBOffset;   /**< Offset of Phase B current sensing network  */
  uint16_t Half_PWMPeriod;     /**< Half PWM Period in timer clock counts */
  volatile uint16_t hFlags;   /**< Variable containing private flags */
  volatile uint8_t  bIndex;
  uint32_t wADCTriggerSet;  /**< Store the value for ADC CR2 to proper configure
                                 current sampling during the context switching*/
  uint32_t wADCTriggerUnSet;/**< Store the value for ADC CR2 to disable the
                                 current sampling during the context switching*/
  bool OverCurrentFlag;     /*!< This flag is set when an overcurrent occurs.*/
  ICS_DDParams_t const *  pParams_str;
} PWMC_ICS_F4_Handle_t;

/* Exported functions ------------------------------------------------------- */

void IF4XX_Init( PWMC_ICS_F4_Handle_t * pHandle );

void IF4XX_CurrentReadingCalibration( PWMC_Handle_t * pHandle );

void IF4XX_GetPhaseCurrents( PWMC_Handle_t * pHandle, Curr_Components * pStator_Currents );

void IF4XX_TurnOnLowSides( PWMC_Handle_t * pHandle );

void IF4XX_SwitchOnPWM( PWMC_Handle_t * pHandle );

void IF4XX_SwitchOffPWM( PWMC_Handle_t * pHandle );

uint16_t IF4XX_WriteTIMRegisters( PWMC_Handle_t * pHandle );

void * IF4XX_IRQHandler( PWMC_Handle_t * pHandle, unsigned char flag );

uint16_t IF4XX_ExecRegularConv( PWMC_Handle_t * pHandle, uint8_t bChannel );

void IF4XX_ADC_SetSamplingTime( PWMC_Handle_t * pHandle, ADConv_t ADConv_struct );

uint16_t IF4XX_IsOverCurrentOccurred( PWMC_Handle_t * pHandle );

void * IF4XX_TIMx_UP_IRQHandler( PWMC_ICS_F4_Handle_t * pHandle );

void * IF4XX_BRK_IRQHandler( PWMC_ICS_F4_Handle_t * pHdl );


/**
  * @}
  */

/**
  * @}
  */

/**
  * @}
  */

#ifdef __cplusplus
}
#endif /* __cpluplus */

#endif /*__ICS_F4XX_PWMNCURRFDBK_H*/

/************************ (C) COPYRIGHT 2018 STMicroelectronics *****END OF FILE****/
